feat: implement HTTP server for remote UEFI shell capability #6

adrianlasota · 2025-09-02T14:52:24Z

This pull request introduces a new remote shell (RShell) connection feature, enabling remote command execution via HTTP between a Python client (including UEFI shell support) and a Flask-based server. The implementation includes the RShell connection class, a sample client, and a server for managing command queues and results.

RShell Connection Implementation

Added the RShellConnection class to mfd_connect/rshell.py, providing methods to start/connect to the RShell server, execute commands remotely, and manage connection lifecycle. This class includes extensive logging and supports command execution via HTTP requests.

Sample Client and Server

Introduced mfd_connect/rshell_client.py, a sample HTTP client designed to run on UEFI shell, which polls for commands, executes them locally, and posts results back to the server. It includes compatibility handling for UEFI shell's limitations.
Added mfd_connect/rshell_server.py, a Flask REST server that manages command queues for each client, provides health checks, serves commands for execution, and collects results. The server supports multiple clients and tracks command status.

Usage Example

Included examples/rshell_example.py demonstrating how to use the new RShellConnection class to connect to a remote RShell server, execute a command, and disconnect.

mfd-intel-bot · 2025-09-02T14:53:36Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:53:49Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:55:19Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:55:32Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

Copilot

Pull Request Overview

This PR implements a remote shell (RShell) capability that enables HTTP-based command execution between a Python client and Flask server, with specific support for UEFI shell environments.

Key changes:

Added RShellConnection class for managing remote command execution via HTTP
Implemented Flask-based server for handling command queues and client connections
Created UEFI-compatible HTTP client with specialized handling for UEFI shell limitations

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 7 comments.

File	Description
mfd_connect/rshell_server.py	Flask REST server managing command queues, health checks, and result collection
mfd_connect/rshell_client.py	HTTP client designed for UEFI shell with polling and command execution capabilities
mfd_connect/rshell.py	RShellConnection class providing remote command execution interface
examples/rshell_example.py	Usage example demonstrating RShellConnection functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-03T07:54:38Z

mfd_connect/rshell_server.py

+def get_command_to_execute():
+    """Get the next command to execute for the connected client."""
+    ip_address = str(request.remote_addr)
+    global client_connected


The variable client_connected is referenced but never defined. This will cause a NameError at runtime.

Suggested change

global client_connected

# global client_connected # Removed: not defined or used

Copilot · 2025-09-03T07:54:38Z

mfd_connect/rshell_server.py

+        print(f"Client connected: {ip_address}")
+    clients.append(ip_address)


The client IP address is always appended to the clients list, even if it already exists. This will create duplicate entries. The append should be inside the if block.

Suggested change

print(f"Client connected: {ip_address}")

clients.append(ip_address)

clients.append(ip_address)

mfd_connect/rshell_client.py

Copilot · 2025-09-03T07:54:39Z

mfd_connect/rshell_client.py

+    except Exception as exp:
+        conn.request(
+            "POST",
+            str("Exception"),


The URL path should be '/post_result' instead of 'Exception' to match the server endpoint.

Suggested change

str("Exception"),

"post_result",

Copilot · 2025-09-03T07:54:39Z

mfd_connect/rshell.py

+        if env is not None:
+            logger.log(
+                level=log_levels.MODULE_DEBUG,
+                msg="Environment variables are not supported for RShellConnection and will be ignored.",
+            )


This check for env is not None is duplicated. The second occurrence (lines 134-138) should be removed as it's identical to lines 128-132.

Suggested change

if env is not None:

logger.log(

level=log_levels.MODULE_DEBUG,

msg="Environment variables are not supported for RShellConnection and will be ignored.",

)

Copilot · 2025-09-03T07:54:39Z

mfd_connect/rshell.py

+                msg="Skipping logging is not supported for RShellConnection and will be ignored.",
+            )
+
+        if expected_return_codes is not None:


The parameter expected_return_codes uses ellipsis (...) as default value but is checked against None. This will always be False since ellipsis is not None.

Copilot · 2025-09-03T07:54:40Z

mfd_connect/rshell.py

+        timeout_string = " " if timeout is None else f" with timeout {timeout} seconds"
+        logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}', {timeout_string}")


The log message formatting is incorrect. It should be f\"Executing >{self._ip}> '{command}'{timeout_string}\" to properly concatenate the timeout information.

Suggested change

timeout_string = " " if timeout is None else f" with timeout {timeout} seconds"

logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}', {timeout_string}")

logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}'{timeout_string}")

mfd-intel-bot · 2025-09-29T10:04:46Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-29T10:05:07Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-07T13:15:17Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-07T13:15:28Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

Signed-off-by: Lasota, Adrian <[email protected]>

mfd-intel-bot · 2025-10-16T07:08:35Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-16T07:08:49Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

adrianlasota temporarily deployed to pypi September 2, 2025 14:52 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from 7904675 to b38783f Compare September 2, 2025 14:54

adrianlasota temporarily deployed to pypi September 2, 2025 14:54 — with GitHub Actions Inactive

adrianlasota requested a review from Copilot September 3, 2025 07:51

Copilot AI reviewed Sep 3, 2025

View reviewed changes

adrianlasota force-pushed the MFD-7178 branch from b38783f to 1fea908 Compare September 29, 2025 10:03

adrianlasota temporarily deployed to pypi September 29, 2025 10:03 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from 1fea908 to dfe39e4 Compare October 7, 2025 13:14

adrianlasota temporarily deployed to pypi October 7, 2025 13:14 — with GitHub Actions Inactive

feat: implement HTTP server for remote UEFI shell capability

abcb17d

Signed-off-by: Lasota, Adrian <[email protected]>

adrianlasota force-pushed the MFD-7178 branch from dfe39e4 to abcb17d Compare October 16, 2025 07:07

adrianlasota temporarily deployed to pypi October 16, 2025 07:07 — with GitHub Actions Inactive

	global client_connected
	# global client_connected # Removed: not defined or used

		print(f"Client connected: {ip_address}")
		clients.append(ip_address)

		timeout_string = " " if timeout is None else f" with timeout {timeout} seconds"
		logger.log(level=log_levels.CMD, msg=f"Executing >{self._ip}> '{command}', {timeout_string}")

feat: implement HTTP server for remote UEFI shell capability #6

Are you sure you want to change the base?

feat: implement HTTP server for remote UEFI shell capability #6

Uh oh!

Conversation

adrianlasota commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

mfd-intel-bot commented Sep 29, 2025

Uh oh!

mfd-intel-bot commented Sep 29, 2025

Uh oh!

mfd-intel-bot commented Oct 7, 2025

Uh oh!

mfd-intel-bot commented Oct 7, 2025

Uh oh!

mfd-intel-bot commented Oct 16, 2025

Uh oh!

mfd-intel-bot commented Oct 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants